/*
 * OREKIT-X
 * Copyright 2002-2008 CS Communication & Systemes
 * 
 * Parts of this software package have been licensed to CS
 * Communication & Systemes (CS) under one or more contributor license
 * agreements.  See the NOTICE file distributed with this work for
 * additional information.
 *  
 * This is an experimental copy of OREKIT from www.orekit.org.
 * Please use the original OREKIT from orekit.org for normal work
 * unrelated to this research project.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License.  You
 * may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied.  See the License for the specific language governing
 * permissions and limitations under the License.
 */
package ore.propagation.events;

import ore.SpacecraftState;
import ore.errors.OrekitException;

/** 
 * Common parts shared by several orbital events finders.
 * 
 * @see ore.propagation.Propagator#addEventDetector(EventDetector)
 * 
 * @author Luc Maisonobe
 */
public abstract class AbstractDetector
    implements EventDetector
{

    /** 
     * Max check interval.
     */
    private final double maxCheck;
    /** 
     * Convergence threshold.
     */
    private final double threshold;


    /** 
     * @param maxCheck maximal check interval
     * @param threshold convergence threshold
     */
    protected AbstractDetector(final double maxCheck, final double threshold) {
        super();
        this.maxCheck  = maxCheck;
        this.threshold = threshold;
    }


    /**
     * {@inheritDoc}
     */
    public abstract int eventOccurred(SpacecraftState s, boolean increasing)
        throws OrekitException;
    /**
     * {@inheritDoc}
     */
    public abstract double g(SpacecraftState s) throws OrekitException;
    /**
     * {@inheritDoc}
     */
    public double getMaxCheckInterval() {
        return this.maxCheck;
    }
    /**
     * {@inheritDoc} 
     */
    public int getMaxIterationCount() {
        return 100;
    }
    /** 
     * {@inheritDoc}
     */
    public double getThreshold() {
        return this.threshold;
    }
    /**
     * {@inheritDoc}
     */
    public SpacecraftState resetState(SpacecraftState state) {
        return state;
    }
}
